Vcenter NamespaceManagement Networks Edges VsphereFoundationConfig

Vcenter NamespaceManagement Networks Edges VsphereFoundationConfig schema contains configuration for enabling a vSphere Foundation Load Balancer to load balance Supervisor workload traffic.

This schema was added in vSphere API 9.0.0.0.

JSON Example

{
    "deployment_target": {
        "zones": [
            "string"
        ],
        "storage_policy": "string",
        "deployment_size": "string",
        "availability": "string"
    },
    "interfaces": [
        {
            "personas": [
                "string"
            ],
            "network": {
                "network_type": "string",
                "dvpg_network": {
                    "name": "string",
                    "network": "string",
                    "ipam": "string",
                    "ip_config": {
                        "ip_ranges": [
                            {
                                "address": "string",
                                "count": 0
                            }
                        ],
                        "gateway": "string"
                    }
                }
            }
        }
    ],
    "network_services": {
        "dns": {
            "servers": [
                "string"
            ],
            "search_domains": [
                "string"
            ]
        },
        "ntp": {
            "servers": [
                "string"
            ]
        },
        "syslog": {
            "endpoint": "string",
            "certificate_authority_pem": "string"
        }
    }
}

deployment_target

Optional

Customize the placement of the Load Balancer.

This property was added in vSphere API 9.0.0.0.

If missing or null, the load balancer will be placed using its default configuration. See fields in Vcenter NamespaceManagement Networks Edges Foundation DeploymentTarget for a description of each default configuration.

array of Vcenter NamespaceManagement Networks Edges Foundation NetworkInterface

interfaces

Optional

Customize the network interfaces of the Load Balancer. For details, see Vcenter NamespaceManagement Networks Edges Foundation Persona

Supported network interface/persona combinations currently include:

One interface with combined Frontend and Management Personas
One interface with Management Persona, one interface with Frontend Persona
One interface with Management Persona, one interface with Frontend Persona, one interface with Backend Persona

This property was added in vSphere API 9.0.0.0.

If no interfaces are configured, then the load balancer will be attached to the Supervisor's management and workload networks when applicable.

If a Supervisor is provisioned with two networks, the following interface configuration is created:

Interface IndexPersona(s)Network 1Management PersonaSupervisor Management Network 2Workload Persona, Frontend PersonaSupervisor Workload Network

In this context management traffic is isolated from workload and load balancer traffic.

If a Supervisor is provisioned with one network, the following interface configuration is created.

Interface IndexPersona(s)Network 1Management Persona, Workload Persona, Frontend PersonaSupervisor Workload Network

In this context a single interface is used for management, workload, and load balancer traffic.

network_services

Optional

Configure network services for this load balancer. Network services increase the reliability of your load balancer.

Network services must be accessible from a network interface with a Management Persona.

This property was added in vSphere API 9.0.0.0.

If missing or null, and Vcenter NamespaceManagement Networks Edges VsphereFoundationConfig.interfaces is unset, the load balancer will inherit settings from the Supervisor. If the an interface configured with a Management Persona is connected to a DHCP network, it will attempt to obtain its settings from a DHCP server. Otherwise, no services will be configured.

Availability of your load balancer may be reduced if network services are not configured. Therefore, it is highly recommended you ensure that network services are configured for your load balancer.